Interface HashTableInterface<E extends KeyedElementInterface<K>,K>

Type Parameters:

E - This parameter is a generic for the type of elements that will be stored in the hash table. Please note that all elements must implement the KeyedElement interface. If the elements, themselves, do not implement the KeyedElement interface, a super-class of element must implement the KeyedElement interface.

K - This parameter is a generic for the type of key each element must have.

All Superinterfaces:

java.lang.Iterable<E>

public interface HashTableInterface<E extends KeyedElementInterface<K>,K>
extends java.lang.Iterable<E>

This is the interface for creating a hash table.

Author:

Sameh Fakhouri

Method Summary

Modifier and Type	Method and Description
E	get(K key) This method is used to retrieve an element with the specified key from the hash table.
double	getAverageBucketSize() This method will look at all the buckets in the HashTable and return the average size of all the buckets.
LinkedList<E,K>[]	getBuckets() This method will be used for testing purposes.
int	getSizeOfLargestBucket() This method will look at all the buckets in the HashTable and return the size of the largest bucket.
E	insert(E element) This method adds the specified element to the hash table.
boolean	isEmpty() This method is used to determine if the hash table is empty.
E	remove(K key) This method will remove the element with the specified key from the hash table.
void	removeAll() This method will remove all elements from the hash table, leaving an empty hash table.
int	size() This method will return the size of the hash table.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

size

int size()

This method will return the size of the hash table. The size of the hash table is the number of elements that have been added to the hash table.

Returns:

The size of the hash table.

isEmpty

boolean isEmpty()

This method is used to determine if the hash table is empty.

Returns:

Return true if the hash table is empty, false otherwise.

insert

E insert(E element)

This method adds the specified element to the hash table. If another element with the same key exists in the hash table, that element will be removed before the new element is inserted.

Parameters:

element - The element to be inserted into the hash table

Returns:

If this insertion replaced an existing element, this method will return the replaced element. Otherwise, the method will return null.

get

E get(K key)

This method is used to retrieve an element with the specified key from the hash table.

Parameters:

key - The key of the element being searched for in the hash table

Returns:

This method will return the element found in the hash table. If the element is not found, this method will return null.

remove

E remove(K key)

This method will remove the element with the specified key from the hash table.

Parameters:

key - The key of the element to be removed from the hash table.

Returns:

This method will return the element that is being removed from the hash table. If the element is not found for removal, this method will return null.

removeAll

void removeAll()

This method will remove all elements from the hash table, leaving an empty hash table.

getSizeOfLargestBucket

int getSizeOfLargestBucket()

This method will look at all the buckets in the HashTable and return the size of the largest bucket.

Returns:

The size of the largest bucket in the HashTable.

getAverageBucketSize

double getAverageBucketSize()

This method will look at all the buckets in the HashTable and return the average size of all the buckets.

Returns:

The average size of the buckets in the HashTable.

getBuckets

LinkedList<E,K>[] getBuckets()

This method will be used for testing purposes. The method will return a reference to the buckets array.

Returns:

A reference to the buckets array.